Interface NtpPTProcess

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
NtpPTProcessImpl

public interface NtpPTProcess extends Process
Information provided by the PKI file:

    \class NtpServerProcess
    
    \brief NtpServerProcess handles and manipulates the NTP server process.
    
    \example network().getDevice("Server0").getProcess("NtpServer")
    
Author:
Auto-generated
  • Method Details

    • setEnabled

      void setEnabled(boolean enable)
      Information provided by the PKI file:
      
          \brief Enables or disables the NTP server.
          
          \param enable, true to enable the NTP server, false to disable it.
          
              
      Parameters:
      enable - Takes in a parameter of enable
    • isEnabled

      boolean isEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if the NTP server is enabled, otherwise false.
          
          \return bool, true if the NTP server is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setKeyID

      void setKeyID(int key)
      Information provided by the PKI file:
      
          \brief Sets the NTP authentication key to the specified value.
          
          \param key, the NTP authentication key value.
          
              
      Parameters:
      key - Takes in a parameter of key
    • getKeyId

      int getKeyId()
      Information provided by the PKI file:
      
          \brief Returns the NTP authentication key.
          
          \return long, the value of the NTP authentication key.
          
              
      Returns:
      int Returns a int
    • getServerMd5Str

      String getServerMd5Str()
      Information provided by the PKI file:
      
          \brief Returns the NTP authentication password.
          
          \return string, the NTP authentication password.
          
              
      Returns:
      String Returns a String
    • setServerMd5Str

      void setServerMd5Str(String md5)
      Information provided by the PKI file:
      
          \brief Sets the NTP authentication password.
          
          \param md5, the NTP authentication password.
          
              
      Parameters:
      md5 - Takes in a parameter of md5
    • getNtpServerAuthentication

      boolean getNtpServerAuthentication()
      Information provided by the PKI file:
      
          \brief Get if the server is set to authenticate.
          
          \return bool, true if it is set to authenticate, false if not.
          
              
      Returns:
      boolean Returns a boolean
    • setNtpServerAuthentication

      void setNtpServerAuthentication(boolean yes)
      Information provided by the PKI file:
      
          \brief Set if the server is supposed to authenticate.
          
          \param yes, true if it should be set to authenticate, false if not.
          
              
      Parameters:
      yes - Takes in a parameter of yes
    • setRefClockTime

      void setRefClockTime(String time)
      Information provided by the PKI file:
      
          \brief Set the ref clock time.
          
          \param time, time to set the clock to.  Example time: "Tue May 24 2016 10:21:27.929 UTC".
          
              
      Parameters:
      time - Takes in a parameter of time
    • getRefClockTime

      String getRefClockTime()
      Information provided by the PKI file:
      
          \brief Gets the ref clock time.
          
          \return string, ref clock time.   Example time: "Tue May 24 2016 10:21:27.929 UTC".
          
              
      Returns:
      String Returns a String